Skip to content

docs: restructure README, add agents/integrations sections#18

Merged
benvinegar merged 5 commits intomainfrom
benvinegar/readme-restructure
Feb 17, 2026
Merged

docs: restructure README, add agents/integrations sections#18
benvinegar merged 5 commits intomainfrom
benvinegar/readme-restructure

Conversation

@benvinegar
Copy link
Copy Markdown
Member

Restructure README to match pitch → install → details flow.

New sections:

  • Agents — role table (control/dev/sentry) + capabilities summary
  • Integrations — Slack, GitHub, Email, Sentry, Docker, Cloud browser
  • Adding agents — 3-step guide to create new roles

Style:

  • Cut emdashes, filler words, marketing voice
  • Shorter declarative sentences
  • Lowercase section headers

Section order:
Why → Requirements → Quick Start → Config → Agents → Integrations → How it works → Architecture → Operations → Tests → Adding agents → Security → License

- Reorder: pitch → install → config → agents → integrations → details
- Add Agents section (control/dev/sentry roles table)
- Add Integrations section (Slack, GitHub, Email, Sentry, Docker, Browser)
- Add 'Adding agents' section (3-step guide)
- Cut emdashes, filler words, marketing voice
- Lowercase section headers (match OpenClaw style)
The firewall is an egress allowlist, not exfiltration prevention.
Data can leave through allowed channels (GitHub, Slack, etc.).
The firewall allows 80/443 to any destination. It's a port allowlist,
not a host allowlist. The value is blocking reverse shells on non-standard
ports, raw sockets, SMTP, and localhost services.
- tool-guard is deployed read-only, not compiled
- manifest is checked by security audit, not auto-verified by agent
@benvinegar benvinegar merged commit b9a8cdf into main Feb 17, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant